home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1336.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.6 KB  |  161 lines
  1. 80
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. GetVolume 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baGetVolume gets the current volume level of wave files and audio CD.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baGetVolume( Device  )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String. 
  36. --- RECORDSEPARATOR ---
  37. Device is the device to get the volume of. Can be:
  38. --- RECORDSEPARATOR ---
  39.  
  40. --- RECORDSEPARATOR ---
  41. Windows:
  42. --- RECORDSEPARATOR ---
  43.  
  44. --- RECORDSEPARATOR ---
  45. "master" 
  46. --- RECORDSEPARATOR ---
  47. gets the master volume 
  48. --- RECORDSEPARATOR ---
  49. "wave" 
  50. --- RECORDSEPARATOR ---
  51. gets the volume of wave and video files 
  52. --- RECORDSEPARATOR ---
  53. "cd" 
  54. --- RECORDSEPARATOR ---
  55. gets the volume of audio CD playback 
  56. --- RECORDSEPARATOR ---
  57. "midi" 
  58. --- RECORDSEPARATOR ---
  59. gets the volume of an external midi device 
  60. --- RECORDSEPARATOR ---
  61. "synth" 
  62. --- RECORDSEPARATOR ---
  63. gets the volume of the internal FM synthesizer 
  64. --- RECORDSEPARATOR ---
  65. "master mute" 
  66. --- RECORDSEPARATOR ---
  67. gets the master mute state 
  68. --- RECORDSEPARATOR ---
  69. "wave mute" 
  70. --- RECORDSEPARATOR ---
  71. gets the wave mute state 
  72. --- RECORDSEPARATOR ---
  73. "cd mute" 
  74. --- RECORDSEPARATOR ---
  75. gets the CD mute state 
  76. --- RECORDSEPARATOR ---
  77. "synth mute" 
  78. --- RECORDSEPARATOR ---
  79. gets the built-in synthesizer mute state
  80. --- RECORDSEPARATOR ---
  81.  
  82. --- RECORDSEPARATOR ---
  83. Macintosh:
  84. --- RECORDSEPARATOR ---
  85.  
  86. --- RECORDSEPARATOR ---
  87. "speakers" 
  88. --- RECORDSEPARATOR ---
  89. gets the volume of external speakers 
  90. --- RECORDSEPARATOR ---
  91. "wave" 
  92. --- RECORDSEPARATOR ---
  93. gets the volume of the internal speaker
  94. --- RECORDSEPARATOR ---
  95.  
  96. --- RECORDSEPARATOR ---
  97. Returns:
  98. --- RECORDSEPARATOR ---
  99.  
  100. --- RECORDSEPARATOR ---
  101. Integer. 
  102. --- RECORDSEPARATOR ---
  103. Returns the volume of the requested device. The volume level can be between 0 
  104. --- RECORDSEPARATOR ---
  105. (silence) and 100 (maximum). The mute options will return 1 if the mute is on, or 0 
  106. --- RECORDSEPARATOR ---
  107. if it isn't. 
  108. --- RECORDSEPARATOR ---
  109. Returns -1 if the function is not supported.
  110. --- RECORDSEPARATOR ---
  111.  
  112. --- RECORDSEPARATOR ---
  113. Examples:
  114. --- RECORDSEPARATOR ---
  115.  
  116. --- RECORDSEPARATOR ---
  117. Director: 
  118. --- RECORDSEPARATOR ---
  119. set Volume = baGetVolume( "wave" ) 
  120. --- RECORDSEPARATOR ---
  121. Authorware: 
  122. --- RECORDSEPARATOR ---
  123. Volume := baGetVolume( "wave" )
  124. --- RECORDSEPARATOR ---
  125.  
  126. --- RECORDSEPARATOR ---
  127. Notes:
  128. --- RECORDSEPARATOR ---
  129.  
  130. --- RECORDSEPARATOR ---
  131. Not all sound cards on Windows support this function. Some cards will only support 
  132. --- RECORDSEPARATOR ---
  133. some of the device types. They will return -1 if 
  134. --- RECORDSEPARATOR ---
  135. the function is not supported. 
  136. --- RECORDSEPARATOR ---
  137. The function will get the volume from the first sound card found. 
  138. --- RECORDSEPARATOR ---
  139. If the left and right channels are at different levels, then the average of the two is 
  140. --- RECORDSEPARATOR ---
  141. returned. 
  142. --- RECORDSEPARATOR ---
  143. Some sound cards do not set the volume precisely. For example, if you set the 
  144. --- RECORDSEPARATOR ---
  145. volume to 50 using the baSetVolume function, then call this function, it may return 
  146. --- RECORDSEPARATOR ---
  147. an 48 or 49. 
  148. --- RECORDSEPARATOR ---
  149. On
  150. --- RECORDSEPARATOR ---
  151.  Macintosh
  152. --- RECORDSEPARATOR ---
  153. , you can also use "master" for "speakers".
  154. --- RECORDSEPARATOR ---
  155.  
  156. --- RECORDSEPARATOR ---
  157. See also:
  158. --- RECORDSEPARATOR ---
  159.  
  160. --- RECORDSEPARATOR ---
  161. baSetVolume